<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Enumerated Types</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__i2s__enums.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">Enumerated Types<div class="ingroups"><a class="el" href="group__group__i2s.html">I2S          (Inter-IC Sound)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga49f7fb887e336a0b459c022cd99f4fa3"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__i2s__enums.html#ga49f7fb887e336a0b459c022cd99f4fa3">cy_en_i2s_status_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga49f7fb887e336a0b459c022cd99f4fa3a2f64d83f74b115135886e89ca315a98b">CY_I2S_SUCCESS</a> = 0x00UL, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga49f7fb887e336a0b459c022cd99f4fa3a3db820e880e7edd1134e48b23028e33c">CY_I2S_BAD_PARAM</a> = CY_I2S_ID | CY_PDL_STATUS_ERROR | 0x01UL
<br />
 }<tr class="memdesc:ga49f7fb887e336a0b459c022cd99f4fa3"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S status definitions.  <a href="group__group__i2s__enums.html#ga49f7fb887e336a0b459c022cd99f4fa3">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga49f7fb887e336a0b459c022cd99f4fa3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac2ba15c8dab8fc0c422ab369992636f5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__i2s__enums.html#gac2ba15c8dab8fc0c422ab369992636f5">cy_en_i2s_alignment_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggac2ba15c8dab8fc0c422ab369992636f5a119e7078944f63177347a7be6efb80f2">CY_I2S_LEFT_JUSTIFIED</a> = 0U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggac2ba15c8dab8fc0c422ab369992636f5ae42d0ade64f2daf741c905db1034188b">CY_I2S_I2S_MODE</a> = 1U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggac2ba15c8dab8fc0c422ab369992636f5a3351542ae68f5c291be19e438b637d2e">CY_I2S_TDM_MODE_A</a> = 2U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggac2ba15c8dab8fc0c422ab369992636f5ade83de64ef77b83b0d76e0bd836333f3">CY_I2S_TDM_MODE_B</a> = 3U
<br />
 }<tr class="memdesc:gac2ba15c8dab8fc0c422ab369992636f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S data alignment.  <a href="group__group__i2s__enums.html#gac2ba15c8dab8fc0c422ab369992636f5">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gac2ba15c8dab8fc0c422ab369992636f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23a77f23cf018c0a0ca3874a0709a630"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__i2s__enums.html#ga23a77f23cf018c0a0ca3874a0709a630">cy_en_i2s_len_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630a17cffa5a44d138153bd3c332e1bb9997">CY_I2S_LEN8</a> = 0U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630a4b0d03407d5b1d135784e77570613ae5">CY_I2S_LEN16</a> = 1U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630ad17c1c6bde060b82e16a1afe4cd54f9c">CY_I2S_LEN18</a> = 2U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630a3a4796f73d6212cf6ac6c4d48e28d570">CY_I2S_LEN20</a> = 3U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630ad4df0a1f7ef1479e25b9f351343830b0">CY_I2S_LEN24</a> = 4U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga23a77f23cf018c0a0ca3874a0709a630aab5c007ec4211c0c0fb92cce4e886d21">CY_I2S_LEN32</a> = 5U
<br />
 }<tr class="memdesc:ga23a77f23cf018c0a0ca3874a0709a630"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S channel/word length.  <a href="group__group__i2s__enums.html#ga23a77f23cf018c0a0ca3874a0709a630">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga23a77f23cf018c0a0ca3874a0709a630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace34f02636657f8a8f1290fcbc5acfa6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__i2s__enums.html#gace34f02636657f8a8f1290fcbc5acfa6">cy_en_i2s_overhead_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggace34f02636657f8a8f1290fcbc5acfa6ab0df85606cde8ff2d5b0c58dd3f7193c">CY_I2S_OVHDATA_ZERO</a> = 0U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#ggace34f02636657f8a8f1290fcbc5acfa6ac3e9674f2da43bb4005842bf4d10e109">CY_I2S_OVHDATA_ONE</a> = 1U
<br />
 }<tr class="memdesc:gace34f02636657f8a8f1290fcbc5acfa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S TX overhead value.  <a href="group__group__i2s__enums.html#gace34f02636657f8a8f1290fcbc5acfa6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:gace34f02636657f8a8f1290fcbc5acfa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga265f4e0f0d40f96b383a91aab3215f79"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__i2s__enums.html#ga265f4e0f0d40f96b383a91aab3215f79">cy_en_i2s_ws_pw_t</a> { <br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga265f4e0f0d40f96b383a91aab3215f79ac9f847e197553fbefa9ed4aec21af028">CY_I2S_WS_ONE_SCK_CYCLE</a> = 0U, 
<br />
&#160;&#160;<a class="el" href="group__group__i2s__enums.html#gga265f4e0f0d40f96b383a91aab3215f79a4ac9c0b6c81f4ceb4fa17f83ff96e912">CY_I2S_WS_ONE_CHANNEL_LENGTH</a> = 1U
<br />
 }<tr class="memdesc:ga265f4e0f0d40f96b383a91aab3215f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S WS pulse width.  <a href="group__group__i2s__enums.html#ga265f4e0f0d40f96b383a91aab3215f79">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga265f4e0f0d40f96b383a91aab3215f79"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga49f7fb887e336a0b459c022cd99f4fa3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49f7fb887e336a0b459c022cd99f4fa3">&#9670;&nbsp;</a></span>cy_en_i2s_status_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__i2s__enums.html#ga49f7fb887e336a0b459c022cd99f4fa3">cy_en_i2s_status_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>I2S status definitions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga49f7fb887e336a0b459c022cd99f4fa3a2f64d83f74b115135886e89ca315a98b"></a>CY_I2S_SUCCESS&#160;</td><td class="fielddoc"><p>Successful. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga49f7fb887e336a0b459c022cd99f4fa3a3db820e880e7edd1134e48b23028e33c"></a>CY_I2S_BAD_PARAM&#160;</td><td class="fielddoc"><p>One or more invalid parameters. </p>
</td></tr>
</table>

</div>
</div>
<a id="gac2ba15c8dab8fc0c422ab369992636f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac2ba15c8dab8fc0c422ab369992636f5">&#9670;&nbsp;</a></span>cy_en_i2s_alignment_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__i2s__enums.html#gac2ba15c8dab8fc0c422ab369992636f5">cy_en_i2s_alignment_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>I2S data alignment. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac2ba15c8dab8fc0c422ab369992636f5a119e7078944f63177347a7be6efb80f2"></a>CY_I2S_LEFT_JUSTIFIED&#160;</td><td class="fielddoc"><p>Left justified. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac2ba15c8dab8fc0c422ab369992636f5ae42d0ade64f2daf741c905db1034188b"></a>CY_I2S_I2S_MODE&#160;</td><td class="fielddoc"><p>I2S mode. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac2ba15c8dab8fc0c422ab369992636f5a3351542ae68f5c291be19e438b637d2e"></a>CY_I2S_TDM_MODE_A&#160;</td><td class="fielddoc"><p>TDM mode A. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac2ba15c8dab8fc0c422ab369992636f5ade83de64ef77b83b0d76e0bd836333f3"></a>CY_I2S_TDM_MODE_B&#160;</td><td class="fielddoc"><p>TDM mode B. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga23a77f23cf018c0a0ca3874a0709a630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23a77f23cf018c0a0ca3874a0709a630">&#9670;&nbsp;</a></span>cy_en_i2s_len_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__i2s__enums.html#ga23a77f23cf018c0a0ca3874a0709a630">cy_en_i2s_len_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>I2S channel/word length. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630a17cffa5a44d138153bd3c332e1bb9997"></a>CY_I2S_LEN8&#160;</td><td class="fielddoc"><p>Channel/word length: 8 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630a4b0d03407d5b1d135784e77570613ae5"></a>CY_I2S_LEN16&#160;</td><td class="fielddoc"><p>Channel/Word length: 16 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630ad17c1c6bde060b82e16a1afe4cd54f9c"></a>CY_I2S_LEN18&#160;</td><td class="fielddoc"><p>Channel/Word length: 18 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630a3a4796f73d6212cf6ac6c4d48e28d570"></a>CY_I2S_LEN20&#160;</td><td class="fielddoc"><p>Channel/Word length: 20 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630ad4df0a1f7ef1479e25b9f351343830b0"></a>CY_I2S_LEN24&#160;</td><td class="fielddoc"><p>Channel/Word length: 24 bit. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga23a77f23cf018c0a0ca3874a0709a630aab5c007ec4211c0c0fb92cce4e886d21"></a>CY_I2S_LEN32&#160;</td><td class="fielddoc"><p>Channel/Word length: 32 bit. </p>
</td></tr>
</table>

</div>
</div>
<a id="gace34f02636657f8a8f1290fcbc5acfa6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gace34f02636657f8a8f1290fcbc5acfa6">&#9670;&nbsp;</a></span>cy_en_i2s_overhead_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__i2s__enums.html#gace34f02636657f8a8f1290fcbc5acfa6">cy_en_i2s_overhead_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>I2S TX overhead value. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggace34f02636657f8a8f1290fcbc5acfa6ab0df85606cde8ff2d5b0c58dd3f7193c"></a>CY_I2S_OVHDATA_ZERO&#160;</td><td class="fielddoc"><p>Fill overhead bits by zeroes. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggace34f02636657f8a8f1290fcbc5acfa6ac3e9674f2da43bb4005842bf4d10e109"></a>CY_I2S_OVHDATA_ONE&#160;</td><td class="fielddoc"><p>Fill overhead bits by ones. </p>
</td></tr>
</table>

</div>
</div>
<a id="ga265f4e0f0d40f96b383a91aab3215f79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga265f4e0f0d40f96b383a91aab3215f79">&#9670;&nbsp;</a></span>cy_en_i2s_ws_pw_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__group__i2s__enums.html#ga265f4e0f0d40f96b383a91aab3215f79">cy_en_i2s_ws_pw_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>I2S WS pulse width. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga265f4e0f0d40f96b383a91aab3215f79ac9f847e197553fbefa9ed4aec21af028"></a>CY_I2S_WS_ONE_SCK_CYCLE&#160;</td><td class="fielddoc"><p>WS pulse width is one SCK cycle. </p>
</td></tr>
<tr><td class="fieldname"><a id="gga265f4e0f0d40f96b383a91aab3215f79a4ac9c0b6c81f4ceb4fa17f83ff96e912"></a>CY_I2S_WS_ONE_CHANNEL_LENGTH&#160;</td><td class="fielddoc"><p>WS pulse width is one channel length. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
